package com.summer.learn.handlers;

import com.summer.learn.modle.User;
import com.sun.tracing.dtrace.ModuleAttributes;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;

@SessionAttributes(value = {"user"}, types = {String.class})
@RequestMapping("testSpringMvc")
@Controller
public class RequestMappingTest {

    /**
     * 1. @RequestMapping 注解除了修饰方法，还可以修饰类
     * 2. 用于类定义：提供初步得请求映射，相对于 WEB 应用的根目录
     *    用于方法定义：提供进一步的细分映射，相对于类定义的 URL 下的
     */
    @RequestMapping("testRequestMapping")
    public String testRequestMapping() {
        System.out.println("testRequestMapping");
        return "hello";
    }

    /**
     * 比较常用，限定请求方法的注解
     */
    @RequestMapping(value = "testMethod", method = RequestMethod.POST)
    public String testMethod() {
        System.out.println("testMethod");
        return "hello";
    }

    /**
     * 需要了解这种映射方式，可以通过 请求参数（params）和 请求头（headers）来精准映射，并且支持简单的表达式。如可以等于某值，或不能等于某值
     */
    @RequestMapping(value = "testParamsAndHeaders", params = {"userName", "age!=10"}, headers = {"Accept-Language=zh-CN,zh;q=0.9"})
    public String testParamsAndHeaders() {
        System.out.println("testParamsAndHeaders");
        return "hello";
    }

    /**
     * Ant 风格资源地址支持3种匹配符
     * ?: 匹配一个字符
     * *: 匹配任意字符
     * **: 匹配多层路径
     */
    @RequestMapping("testAntPath/*/abc")
    public String testAntPath() {
        System.out.println("testAntPath");
        return "hello";
    }

    /**
     * PathVariable 占位符方式的注解隐射。
     * 带占位符的url是spring3.0新增的功能，该功能在 SpringMVC 向 REST 风格目标发展过程中具有里程碑式意义
     * 通过@PathVariable可以将 URL 占位符参数绑定到控制器处理方法的入参中，但需要保持占位符与注解定义名称保持一致 如 testPathVariable/{id} 必须使用 @PathVariable("id")
     */
    @RequestMapping("testPathVariable/{id}")
    public String testPathVariable(@PathVariable("id") Integer id) {
        System.out.println("testPathVariable" + id);
        return "hello";
    }

    /**
     * Rest 风格的 URL
     * 以 CRUD 为例:
     *       REST风格             非 REST 风格
     * 新增: /order POST
     * 修改: /order/1 PUT         update?id=1
     * 获取: /order/1 GET         get?id=1
     * 册除: /order/1 DELETE      delete?id=1
     *
     * 如何发送 PUT 请求和 DELETE 请求呢?
     * 1. 需要在 web.xml 中配置过滤器 HiddenHttpMethodFilter
     * 2. 需要使用表单 form 发送 POST 请求
     * 3. 需要在发送 POST 请求时携带一个 name="_method" 的隐藏域，值为 DELETE 或 PUT
     * JS 中代码调用可以直接指定 method 为 DELETE 或 PUT
     *
     * 在 SpringMVC 的目标方法中如何得到id呢?
     * 使用 @PathVariable 注解
     * */
    @RequestMapping(value = "testRest", method = RequestMethod.POST)
    public String testRest() {
        System.out.println("testRest POST");
        return "hello";
    }

    @RequestMapping(value = "testRest/{id}", method = RequestMethod.GET)
    public String testRest(@PathVariable("id") Integer id) {
        System.out.println("testRest GET" + id);
        return "hello";
    }

    @RequestMapping(value = "testRest/{id}", method = RequestMethod.DELETE)
    public String testRestDel(@PathVariable("id") Integer id) {
        System.out.println("testRest DELETE" + id);
        return "hello";
    }

    @RequestMapping(value = "testRest/{id}", method = RequestMethod.PUT)
    public String testRestPut(@PathVariable("id") Integer id) {
        System.out.println("testRest PUT" + id);
        return "hello";
    }

    /**
     * @RequestParam 来映射请求参数·
     * value        值即请求参数的参数名
     * required     该参数是否必须。默认为 true
     * defaultValue 请求参数的默认值
     *
     * 也可以不指定注解，来接受，但是变量名必须与参数名一致，但早期java版本对于参数名会进行磨出，所以并不是特别好。或者混淆代码后名称可能对不上。
     * */
    @RequestMapping("testRequestParam")
    public String testRequestParam(@RequestParam("userName") String un, @RequestParam(value = "age", required = false, defaultValue = "0") int age, String sex) {
        System.out.println("testRequestParam userName：" + un + ", age:" + age + ", sex:" + sex);
        return "hello";
    }

    /**
     * 用法同 @RequestParam
     * 使用机会较少
     */
    @RequestMapping("testRequestHeader")
    public String testRequestHeader(@RequestHeader("Accept-Language") String al) {
        System.out.println("testRequestHeader Accept-Language：" + al);
        return "hello";
    }

    /**
     * 了解:
     * @CookieValue : 映射一个 Cookie 值。用法同 @RequestParam
     */
    @RequestMapping("testCookieValue")
    public String testCookieValue(@CookieValue("JSESSIONID") String id) {
        System.out.println("testCookieValue JSESSIONID：" + id);
        return "hello";
    }

    /**
     * Spring MVC会按请求参数名和 POJO 属性名进行自动匹配，
     * 自动为该对象填充属性值。支持级联属性。如:address.province、address.city 等
     * 注意：POJO必须提供 get/set 方法，否则不会自动填充
     * */
    @RequestMapping("testPOJO")
    public String testPOJO(User user) {
        System.out.println("testPOJO ：" + user);
        return "hello";
    }

    /**
     * 注意需要使用原生 Servlet API 需要引入 servlet-api 包，可以去 maven 仓库查找，使用 Tomcat Servlet API 的或者 Java Servlet API 的都可以
     * 可以使用 Servlet 原生的API作为目标方法的参数具体支持以下类型
     * HttpServletRequest
     * HttpServletResponse
     * Httpsession
     * java.security.Principal
     * Locale
     * InputStream
     * outputStream
     * Reader
     * writer
     */
    @RequestMapping("testServletAPI")
    public void testServletAPI(HttpServletRequest request, HttpServletResponse response, Writer out) throws IOException {
        System.out.println("testServletAPI ：\n" + request +"\n" + response);
        out.write("hello springmvc");
//        return "hello";
    }

    ///------------------------------下面是将模型数据放请求域中-------------------------------------------------------------------
    /**
     * 返回带模型的视图，这里使用 ModelAndView 实现，ModelAndView会再返回前由 SpringMVC 框架渲染器遍历写入 request.setAttribute() 中去，
     * 所以页面可以从 requestScope 请求域中拿去到对应的参数。
     * viewName 参数指具体的页面名
     *
     * 目标方法的返回值可以是 ModelAndView类型。
     * 其中可以包含视图和模型信息
     * SpringMVC会把 ModelAndView 的 model中数据放入到 request 域对象中。
     */
    @RequestMapping("testModelAndView")
    public ModelAndView testModelAndView() {
        ModelAndView modelAndView = new ModelAndView("hello");
        modelAndView.addObject("time", new Date());
        return modelAndView;
    }

    /**
     * 目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数。
     *
     * 传入的map类型实际打印出的是 org.springframework.validation.support.BindingAwareModelMap
     */
    @RequestMapping("testMap")
    public String testMap(Map<String, Object> map) {
        System.out.println("testMap ：" + map.getClass().getName());
        map.put("names", Arrays.asList("summer", "lw", "summer_lw"));
        return "hello";
    }

    ///------------------------------下面是将模型数据放session中-------------------------------------------------------------------

    /**
     * @SessionAttributes 写在类上的注解，用于模型 model 在放入请求域时，同时存一份到session域中，可以通过value名称和value类型匹配是否存入session
     * 除了可以通过属性名指定需要放到会话中的属性外 （注解 value）
     * 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中 （注解 types）
     */
    @RequestMapping("testSessionAttributes")
    public String testSessionAttributes(Map<String, Object> map) {
        User user = new User("summer", "man", 33);
        map.put("user", user);
        map.put("testSessionString", "成了");
//        System.out.println("testMap ：" + map.getClass().getName());
        return "hello";
    }

    /**
     * 1. 有 @ModelAttribute 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用!
     * 2. @ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参，其 value 属性值有如下的作用:
     *  1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象，若存在则会直接传入到目标方法的入参中。
     *  2). SpringMVC 会以 value 为 key，POJO 类型的对象为 value，存入到 request 中。
     */
    @ModelAttribute
    public void getUser(@RequestParam(value = "id", required = false) Integer id, Map<String, Object> map) {
        System.out.println("ModelAttribute===========> getUser :" + id);
        if(id != null) {
            // 模拟数据库中获取一个用户数据
            User user = new User(id, "summer", "man", 5, "aaabbbcccddd");
            System.out.println("getUser:" + user);
            map.put("user", user);
//            map.put("user1", user);
        }
    }

    /**
     * 运行流程:
     * 1. 执行 @ModelAttribute 注解修饰的方法:从数据库中取出对象，把对象放入到了 Map 中。键为: user
     * 2. SpringMVC 从 Map 中取出 User 对象，并把表单的请求参数赋给该 User 对象的对应属性。
     * 3. SpringMVC 把上述对象传入目标方法的参数。
     *
     * 注意:在 @ModelAttribute 修饰的方法中，放入到 Map 时，put的键需要和目标方法入参类型的名字一致，注意第一个字母小写。
     * 例如：testModelAttribute 方法的参数使用了 User 类，那么被 @ModelAttribute 修饰的 getUser 方法中 map.put("user", user); 可以就必须使用类名首字母小写：User => user
     *
     *
     * SpringMVC 确定目标方法 POJO 类型入参的过程：
     * 1。确定一个 key :
     *   1)。若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰，则 key 为 POJO 类名第一个字母的小写
     *   2)。若使用了 @ModelAttribute 来修饰，则 key 为 @ModelAttribute 注解的 value 属性值。
     * 2。在 implicitModel 中查找 key 对应的对象，若存在，则作为入参传入
     *   1)。若在 @ModelAttribute 标记的方法中在 Map 中保存过，且 key 和 1 确定的 key 一致，则会获取到。
     * 3，若 implicitModel 中不存在 key 对应的对象，则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰，
     * 若使用了该注解，且 @SessionAttributes 注解的 value 属性值中包含了 key，则会从 HttpSession 中来获取 key 所对应的 value 值，
     * 若存在则直接传入到目标方法的入参中。若不存在则将抛出异常。
     * 4。若Handler没有标识@SessionAttributes注解或@SessionAttributes 注解的 value值中不包含key,
     * 则会通过反射来创建 POJO 类型的参数,传入为目标方法的参数
     * 5. SpringMVC会把 key 和 POJO 类型的对象保存到 implicitModel 中，进而会保存到 request 中.
     *
     *
     * 源代码分析的流程
     * 1。调用 @ModelAttribute 注解修饰的方法。实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中.
     * 2。解析请求处理器的目标参数，实际上该目标参数来自于 WebDataBinder 对象的 target 属性
     * 1)。创建 WebDataBinder 对象;
     *  ①. 确定 objectName 属性:若传入的 attrName 属性值为 ""，则 objectName 为类名第一个字母小写.
     *  *注意: attrName，若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰，则 attrName 值即为 @ModelAttribute 的 value 属性值
     *  ②。确定 target 属性:
     *  > 在 implicitModel 中查找 attrName 对应的属性值。若存在，ok
     *  > *若不存在: 则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰，若使用了，则尝试从 Session 中获取 attrName 所对应的属性值。若 session 中没有对应的属性值，则抛出了异常.
     *  > 若 Handler 没有使用 @SessionAttributes 进行修饰，或 @SessionAttributes 中没有使用 value 值指定的 key 和 attrName 相匹配,则通过反射创建了 POJO 对象
     *
     * 2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性。
     * 3). *SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel. 近而传到 request 域对象中。
     * 4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参。|
     * */
    @RequestMapping("testModelAttribute")
    public String testModelAttribute(/*@ModelAttribute("user1")*/ User user1) {
        System.out.println("testModelAttribute:" + user1);
        return "hello";
    }

    @RequestMapping("testViewAndViewResolver")
    public String testViewAndViewResolver() {
        return "hello";
    }

    /**
     * 匹配的名字是自定义View类名 第一个字母小写
     */
    @RequestMapping("testSummerView")
    public String testSummerView() {
        return "summerView";
    }

    /**
     * 重定向测试,会根据返回字符串，在创建视图View的时候，确定创建一个重定向视图还是其他
     * UrlBasedViewResolver.createView(String viewName, Locale locale)方法中，
     */
    @RequestMapping("testRedirect")
    public String testRedirect() {
        System.out.println("testRedirect:");
        return "redirect:/index.jsp";
    }

}
